BusInfo Struct Reference
[VST Buses]

Bus Description. More...

#include <ivstcomponent.h>

Public Types

enum  BusFlags { kDefaultActive = 1 << 0 }

Data Fields

MediaType mediaType
 Media type - has to be a value of MediaTypes.
BusDirection direction
 input or output BusDirections
int32 channelCount
 number of channels (if used then need to be recheck after IAudioProcessor::setBusArrangements is called)
String128 name
 name of the bus
BusType busType
 main or aux - has to be a value of BusTypes
uint32 flags
 flags - a combination of BusFlags

Detailed Description

Bus Description.

A bus can be understood as a 'collection of data channels' belonging together. It describes a data input or a data output of the Plug-in. A VST component can define any desired number of buses, but this number must never change. Dynamic usage of buses is handled in the host by activating and deactivating buses. The component has to define the maximum number of supported buses and it has to define which of them are active by default. A host that can handle multiple buses, allows the user to activate buses that were initially inactive.

See also: IComponent::getBusInfo , IComponent::activateBus


Member Enumeration Documentation

enum BusFlags
Enumerator:
kDefaultActive 

bus active per default


Field Documentation

Media type - has to be a value of MediaTypes.

input or output BusDirections

number of channels (if used then need to be recheck after IAudioProcessor::setBusArrangements is called)

name of the bus

main or aux - has to be a value of BusTypes

flags - a combination of BusFlags

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines
Empty

Copyright ©2013 Steinberg Media Technologies GmbH. All Rights Reserved.